home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 006a / rompr120.zip / ROMPROC.DOC < prev    next >
Text File  |  1993-06-17  |  29KB  |  615 lines

  1.  
  2.     ┌────┐
  3.     │──═─│
  4.     │ ── │ ─────┐      ┌────┐             ROMProc Documentation File
  5.     │    │   ROMProc   │──═─│                    Version 1.20
  6.     │    │      └────> │ ── │          (c) Copyright 1993 - Stacy Smith
  7.     │    │             │    │
  8.     │    │             │    │
  9.    ─┴────┴─           ─┴────┴─
  10.  
  11.  
  12.                                 Courtesy of:
  13.  
  14.                         The Bloom Beacon-Picayune BBS
  15.           Node 1: (804) 525-9760 (USRobotics Courier Dual Standard)
  16.              Node 2: (804) 525-5372 (USRobotics Courier V.32bis)
  17.                              FidoNet 1:276/112
  18.                                   Intelec
  19.                              RoseNet (ID: BB-P)
  20.  
  21.                                 Stacy Smith
  22.                               Route 6 Box 189
  23.                            Forest, Virginia 24551
  24.  
  25.  
  26. ┌────────────────────┐
  27. │  1. Introduction:  │
  28. └────────────────────┘
  29.  
  30. ROMProc is a BBS download file preprocessor designed to make optimal use of
  31. CD-ROM and/or LAN BBS setups by copying the desired file(s) from the source
  32. drive into a work directory, commenting them, transferring them to the remote
  33. user with the desired protocol and cleaning up. ROMProc is different from other
  34. programs in which it performs all these functions automatically from a single
  35. program command.
  36.  
  37. By commenting files just prior to download, rather than commenting them when
  38. posted, you will save a lot of disk space and your files will always have
  39. up-to-date comments inserted. By stripping the comments from 200 megs of ZIP
  40. files on my system, I gained about 2 megs of disk space!
  41.  
  42. ROMProc was developed primarily because I didn't like the current crop of
  43. CD-ROM and server file handlers. They were either complicated to install,
  44. didn't perform as desired, were designed as doors, memory hogs, ridiculously
  45. expensive or crippled.
  46.  
  47.  
  48. ┌───────────────────────────┐
  49. │  2. Features of ROMProc:  │
  50. └───────────────────────────┘
  51.  
  52.       ∙ Handles the complete download process from a single command-line.
  53.       ∙ Functions with any protocol, including single, batch and bi-directional
  54.         protocols.
  55.       ∙ May be installed in your BBS software as a batch file or a direct
  56.         command-line.
  57.       ∙ Automatically identifies ARC, ARJ, HYP, LZH, PAK, SQZ, ZIP and ZOO
  58.         files, regardless of their file extensions (ideal for software
  59.         distribution networks, like .SDN files), allowing commenting of these
  60.         archivers that support archive comments (not all do).
  61.       ∙ Automatically identifies ARJ, LZH, PAK, SQZ and ZIP self-extracting
  62.         (SFX) archives.
  63.       ∙ Comments all files prior to downloading, if desired.
  64.       ∙ May be configured to insert a BBS ad file to the archives (ugh).
  65.       ∙ Fully multinode compatible.
  66.       ∙ Locks slow drives to prevent slowdowns due to multiple access to the
  67.         same drive.
  68.       ∙ Outputs sysop-configurable prompts to the user for indication of
  69.         process status. ROMProc supports IRQs 2-7 with any base address as well
  70.         as FOSSIL drivers.
  71.       ∙ Windowed full-screen interface.
  72.       ∙ User-selectable disk error logging.
  73.       ∙ Not crippled.
  74.       ∙ Returns the errorlevel of the transfer protocol, making ROMProc
  75.         completely transparent to the BBS software.
  76.       ∙ Written completely in C for optimal speed, using Microsoft C/C++ 7.0.
  77.       ∙ Lifetime registration; pay ONCE and your registration number will work
  78.         on all future versions!
  79.  
  80.  
  81. ┌─────────────────────────────────────────────────────────┐
  82. │  3. Files Included in the ROMProc Distribution Archive  │
  83. └─────────────────────────────────────────────────────────┘
  84.  
  85.         ROMPROC.EXE     CD-ROM Download File Processor program
  86.         ROMPROC.CFG     Sample configuration file
  87.         ROMPROC.DOC     This file
  88.         HISTORY.TXT     ROMProc revision history in reverse order
  89.         REGISTER.FRM    Registration form for ROMProc
  90.         COMMENT.TXT     Sample comment file for inclusion in archives
  91.         FILE_ID.DIZ     Internal description file
  92.  
  93. When you unzip the distribution archive, you should see my PKZIP authenticity
  94. verification stamp, and a '-AV' after every file in the archive:
  95.  
  96.         # SSU301    The Bloom Beacon-Picayune BBS
  97.  
  98. If there are any files missing or added, or the -AV stamp is missing, the
  99. archive has been tampered with. It would be advisable to call my BBS (listed at
  100. the top of this document) for the latest version of ROMProc.
  101.  
  102.  
  103. ┌───────────────────────────┐
  104. │  4. Program Requirements  │
  105. └───────────────────────────┘
  106.  
  107. To the best of my knowledge, ROMProc will run on most any machine capable of
  108. running a BBS package. My BBS setup is PCBoard 14.5a/10 running under DESQview
  109. on a LANtastic 4.10 network, but other sysops that I have been in contact with
  110. have successfully implemented ROMProc on a wide variety of hardware.
  111.  
  112. ROMProc requires DOS 3.x or later, as it uses DOS SHARE-compatible file reads
  113. and writes.  ROMProc's memory requirements are very small (about 80K, plus
  114. whatever memory is required to invoke the transfer protocols), therefore it can
  115. be run in very low memory situations.
  116.  
  117. ROMProc has been developed and tested using the following archiving and
  118. transfer protocols:
  119.  
  120.         ARJ 2.10 through 2.39 Beta F (by Robert Jung)
  121.         LHA 2.13 (by Haruyasu Yoshizaki)
  122.         PKZIP 1.10 through 2.04g (by PKWare)
  123.         SQZ 1.08.2 (by Jonas Hammarberg)
  124.         DSZ 5/3/93 (by Omen Technology)
  125.         HS/Link 1.12 through 1.20 (by Sam Smith)
  126.  
  127.  
  128. ┌───────────────────┐
  129. │  5. Registration  │
  130. └───────────────────┘
  131.  
  132. ROMProc is not free; nor is ROMProc is crippled to force registration. ROMProc
  133. is fully functional, and will always remain so. The only variation with the
  134. registered copies is no time delay and beg message, and unregistered copies
  135. display the following to the user online at the beginning of execution:
  136.  
  137.     [ ROMProc 1.23 - Unregistered ]
  138.  
  139. Why register? Besides a clean conscience, you will get a registration code that
  140. will work for all future versions of ROMProc, and will remove the delay and
  141. message displayed upon closing the door.
  142.  
  143. The registration fee for your unique code is $10 for non-commercial BBSs (not
  144. too bad, eh?). The registration fee for commercial BBSs, defined if you run
  145. your BBS in the course of a commercial business or for profit, is $20. Other
  146. variations are available; refer to the file REGISTER.FRM for all registration
  147. options. Please print the file REGISTER.FRM and fill it out. You can print out
  148. the form by issuing the following command from the DOS prompt:
  149.  
  150.         TYPE REGISTER.FRM > PRN
  151.  
  152.  
  153. ┌───────────────────────────────────────┐
  154. │  6. License, Warranty and Disclaimer  │
  155. └───────────────────────────────────────┘
  156.  
  157. I'll keep this part short and sweet, and dispense with the legal-ese:
  158.  
  159.         License: You are allowed to use ROMProc for 30 days, after which you
  160.            must either register ROMProc or stop using it completely. ROMProc
  161.            registration is a license for your use of ROMProc; I retain
  162.            ownership of the software. A single registration applies to a single
  163.            BBS system, regardless of the number of computers used in the
  164.            system. If you run two or more distinct BBS systems on the same
  165.            computer(s) (with different names), you require two or more ROMProc
  166.            registrations. Refer to the registration form for the currect
  167.            pricing structure.
  168.  
  169.         Warranty: There isn't one. The only thing I'll guarantee is that
  170.            ROMProc will take up disk space, and will disappear when deleted.
  171.  
  172.         Disclaimer: I'm not responsible for anything bad that happens. ROMProc
  173.            works here, but I cannot be held responsible for it not working on
  174.            your computer or doing any damage to hardware or software.
  175.  
  176. If these aren't agreeable with you, then the best thing to do is delete ROMProc
  177. right now. I'll do my best to help any user (registered or not) that wants to
  178. use ROMProc, and I'll act on bug reports quickly, but I simply cannot and will
  179. not be responsible for anything bad, like lost data, disk crashes, or whatever
  180. else you can think of.
  181.  
  182.  
  183. ┌───────────────────┐
  184. │  7. Installation  │
  185. └───────────────────┘
  186.  
  187. GENERAL INSTALLATION:
  188. ─────────────────────
  189. Make a subdirectory on your hard drive. For the purposes of this document,
  190. we'll call it "C:\ROMPROC". Unarchive the ROMProc distribution archive into
  191. this subdirectory. You've more than likely already made it this far, if you're
  192. reading this file. <grin>
  193.  
  194. The ROMProc system opens a few files simultaneously for various reasons. I
  195. would recommend that you have a minimum of FILES=30 per node in your system
  196. CONFIG.SYS file for a single-node system, since ROMProc is run in conjunction
  197. with your BBS software.
  198.  
  199. If you are running under a network or a multitasking operating system, you
  200. should already have DOS's SHARE.EXE loaded. You must have SHARE loaded in order
  201. to take advantage of the file sharing and locking methods used by the ROMProc
  202. program to prevent data loss. (If you are running a single-node system without
  203. a multitasker, SHARE is not needed).
  204.  
  205. Edit the configuration file to suit your needs. Proper configuration will
  206. require you to refer to this section, the previous section and the section
  207. titled "Configuration", which has an in-depth explanation of each configuration
  208. parameter and its function.
  209.  
  210. Note that for the ROMProc program, you can obtain a limited program syntax
  211. screen simply by executing the program name "ROMPROC".
  212.  
  213. GENERIC INSTALLATION INTO YOUR BBS SOFTWARE:
  214. ────────────────────────────────────────────
  215. The premise behind ROMProc is that instead of invoking your transfer protocol
  216. as usual when sending files to remote, you invoke ROMProc instead. ROMProc will
  217. copy all files the remote user requested, process them as configured and invoke
  218. the desired protocol. Note that only the sending (remote download) protocol is
  219. changed; the receiving (remote upload) procotol is not changed. Upon completion
  220. of the transfer, ROMProc will return the errorlevel returned by the protocol,
  221. ensuring ROMProc's transparency to the BBS software.
  222.  
  223. ROMProc must be run from the BBS node subdirectory; this is required to prevent
  224. conflicts when multiple copies of ROMProc are run simultaneously. At the bare
  225. minimum, three command-line parameters are required for ROMProc:
  226.  
  227.     c:\romproc\romproc -Cc:\romproc\romproc.cfg -Ffile.ext -Tz
  228.  
  229. where -C defines the full path and filename of the configuration file for
  230. ROMProc and -F is the complete path and filename of the file (or batch list
  231. file) to be sent to remote; this parameter is almost always passed by the BBS
  232. software. Also, the required -T parameter defines to ROMProc which protocol to
  233. invoke by letter.
  234.  
  235. When run in a multinode environment, you must also pass the BBS node number
  236. (via the -N command-line switch) to prevent collisions during simultaneous
  237. downloads (if no node number is defined, 0 is used by default):
  238.  
  239.     c:\romproc\romproc -Cc:\romproc\romproc.cfg -Ffile.ext -Tz -N2
  240.  
  241. In many installations, the node number is or can be defined as an environment
  242. variable. For example, PCBoard sysops use the environment variable PCBNODE to
  243. use in batch files for external utilities.
  244.  
  245.     c:\romproc\romproc -Cc:\romproc\romproc.cfg -Ffile.ext -Tz -N%PCBNODE%
  246.  
  247. All BBS software passes the port number and computer-to-modem speed (DTE), and
  248. many also pass modem-to-modem carrier speed (DCE). These are passed on to
  249. ROMProc via the -P, -S and -E command-line switches, respectively. BBS software
  250. that supports bi-directional protocols will also pass the upload directory for
  251. the protocol to place any unexpected uploads from remote. This is passed to
  252. ROMProc using the -U command-line switch.
  253.  
  254. * NOTE: In order for ROMProc to send status information to the online user, you
  255.         MUST define the -P and -S parameters. (The -P may be omitted from the
  256.         command line in favor of the DSZPORT environment variable).
  257.  
  258. Most of the switches are self-explanatory. To be safe, if your BBS system
  259. is capable of passing a parameter, pass it on to ROMProc using the appropriate
  260. command-line switch. It can't hurt...
  261.  
  262. PCBOARD INSTALLATION:
  263. ─────────────────────
  264. Installation in PCBoard is very easy. PCBoard uses two batch files for each
  265. protocol, named PCBR?.BAT and PCBS?.BAT, where ? is the protocol letter. The
  266. PCBR?.BAT (receive) batch files do not need to be changed for ROMProc, however,
  267. the PCBS?.BAT batch file does. Below are sample Zmodem and HS/Link send (and
  268. receive, for reference) batch files from my multinode system:
  269.  
  270. PCBSZ.BAT:
  271. @Echo off
  272. if exist pcberr.fil del pcberr.fil
  273. if exist pcbdsz.log del pcbdsz.log
  274. c:\romproc\romproc -Cc:\romproc\romproc.cfg -Tz -N%PCBNODE% -F%3 -P%1 -S%2 -E%5
  275.  
  276. PCBRZ.BAT:
  277. @Echo off
  278. if exist pcberr.fil del pcberr.fil
  279. if exist pcbdsz.log del pcbdsz.log
  280. dsz port %1 speed %2 ha cts est 0 %5 pB4096 pr1 rz %3
  281.  
  282. PCBSH.BAT:
  283. @Echo off
  284. if exist pcberr.fil del pcberr.fil
  285. if exist pcbdsz.log del pcbdsz.log
  286. c:\romproc\romproc -Cc:\romproc\romproc.cfg -Th -N%PCBNODE% -F%3 -P%1 -S%2 -E%5
  287.     -U%6
  288.  
  289. PCBRH.BAT:
  290. @Echo off
  291. if exist pcberr.fil del pcberr.fil
  292. if exist pcbdsz.log del pcbdsz.log
  293. hslink -b%2 -p%1 -e%5 -u%6 -noc:\pcb\gen\dlpath.lst
  294.  
  295.  
  296. With the exception of the -T parameter, all of your PCBS?.BAT files should be
  297. identical; change the -T parameter to reflect the appropriate protocol letter.
  298. For bi-directional protocols, such as HS/Link and BiModem, add the -U%6 command
  299. switch.
  300.  
  301. If you wish full implementation of ROMProc, all protocols have to be shelled
  302. instead of using the internal Xmodem and Ymodem protocols. Fortunately, DSZ is
  303. capable of all variations of Xmodem and Ymodem as well as Zmodem. The following
  304. is a screen snapshot of my PCBPROT.DAT file from PCBSETUP, with all protocols
  305. running through ROMProc:
  306.  
  307.                        Port Lock
  308.      Use Type Size MNP Open Lines             Protocol Description
  309.      ═══ ════ ════ ═══ ════ ═════ ═══════════════════════════════════════
  310.       A   I    128  N   N     N   ASCII (text files only)
  311.       X   S    128  N   N     Y   Xmodem
  312.       C   S    128  N   N     Y   Xmodem-CRC
  313.       O   S   1024  N   N     Y   1K-Xmodem
  314.       F   S   1024  Y   N     Y   1K-Xmodem/G
  315.       Y   D   1024  N   N     Y   Ymodem    [Batch]
  316.       G   D   1024  Y   N     Y   Ymodem/G  [Batch]
  317.       Z   D   1024  N   N     Y   Zmodem    [Batch]
  318.       M   D   1024  N   N     Y   Zmodem MobyTurbo  [Batch]
  319.       H   B   2048  N   N     Y   HS/Link (bi-directional)  [Batch]
  320.       N   I      0  N   N     N   None (ask each transfer)
  321.  
  322. Note the type for the Xmodem and Ymodem transfer protocols is now (S)helled or
  323. (D)SZLOG batch, instead of (I)nternal.
  324.  
  325. OTHER BBS INSTALLATION:
  326. ───────────────────────
  327.  
  328. * NOTE: As my BBS is PCBoard, I have written the PCBoard-specific instructions.
  329.         I would greatly appreciate some feedback from other BBS software users
  330.         regarding ROMProc installation specifics.
  331.  
  332. APPLICATION NOTES:
  333. ──────────────────
  334. PKZIP:
  335.     PKZIP 2.04 uses direct-video output by default that will make the
  336.     processing window look rather ugly when executed. To remedy this, set the
  337.     PKNOFASTCHAR environment variable which will revert PKZIP 2.04 to the older
  338.     1.10-style video output. (It doesn't matter what your set the variable to,
  339.     PKZIP just looks for its existence).
  340.  
  341. SQZ:
  342.     SQZ also uses direct-video output, but unlike PKZIP 2.04, it cannot be
  343.     defeated. The processing window may look odd, but rest assured it is
  344.     operating correctly.
  345.  
  346. DSZ:
  347.     In many cases, the use of DSZPORT environment variable is more desirable
  348.     than passing the COM port information. This allows easier definition of
  349.     non-standard COM ports addresses. For example, if you are using COM2 for a
  350.     BBS node, add:
  351.  
  352.             SET DSZPORT=2
  353.  
  354.     to your node batch file. If you are running a non-standard COM port, define
  355.     the base address and IRQ on the command line. For example, if COM3 (a
  356.     non-standard port for IBM PCs) is used with 3e8 is the base address and 5
  357.     is the assigned IRQ, the setting would be:
  358.  
  359.             SET DSZPORT=3e8,5
  360.  
  361.     If you elect to use the DSZPORT environment variable, it is no longer
  362.     necessary to pass the -P command-line switch or to add the "port @PORT@"
  363.     parameter to the DSZ command lines for Xmodem, Ymodem, and Zmodem transfers
  364.     in the ROMProc configuration file.
  365.  
  366.     In addition, ROMProc will search the environment for the DSZPORT variable
  367.     and use it for the com port definitions for it's user status output.
  368.  
  369. HS/Link:
  370.     The HS/Link command-line can include the -NF switch to turn off HS/Link's
  371.     full-screen display, allowing it to run in ROMProc's transfer protocol
  372.     window. Otherwise, ROMProc's local display will be overwritten by HS/Link's
  373.     display.
  374.  
  375.  
  376. ┌────────────────────┐
  377. │  8. Configuration  │
  378. └────────────────────┘
  379.  
  380. The sample configuration file included in the distribution archive is heavily
  381. commented, but some additional information is provided below:
  382.  
  383. GENERAL PARAMETERS:
  384. ───────────────────
  385. REG_CODE
  386.     The registration code EXACTLY as provided to you on your registration
  387.     letter. If this is an unregistered version, comment out this line. Note
  388.     that this is case-sensitive, as the serial number, BBS name and sysop name
  389.     are all encrypted into this code.
  390.  
  391. BBS_NAME
  392.     The BBS name EXACTLY as provided to you on your registration letter. If
  393.     this is an unregistered version, comment out this lines. Note that this is
  394.     case-sensitive!
  395.  
  396. SYSOP_NAME
  397.     The sysop name EXACTLY as provided to you on your registration letter. If
  398.     this is an unregistered version, comment out this line. You get the picture
  399.     by now...
  400.  
  401. WORK_DIR
  402.     The full path for the specific subdirectory for ROMProc to store file(s) to
  403.     be downloaded. This must include the trailing backslash! If this directory
  404.     does not exist at runtime, ROMProc will attempt to create it. This can be
  405.     set to a RAM disk for greater speed, since ROMProc will detect an out of
  406.     disk space condition and allow the download to continue from the original
  407.     file.
  408.  
  409. DISK_BUFFER
  410.     The size of the disk I/O buffer you wish to allocate in bytes (valid values
  411.     are between 2048 bytes and 16384 bytes). Optimal performance is obtained
  412.     with a value that is a multiple of 2048 bytes, since this is the size of a
  413.     typical hard disk cluster. 4096 seems to be a good number for me, although
  414.     a larger size will improve performance somewhat. If you find yourself
  415.     running out of memory when executing archivers or protocols, reduce this
  416.     number to increase your available memory. If no value is specified, the
  417.     disk buffer will default to 4096 bytes.
  418.  
  419. LOG_FILE
  420.     The complete path and filename of the log file for ROMProc to record
  421.     errors. Comment the line out if you don't want any disk error logging.
  422.  
  423. LOCK_LINES
  424.     If you want ROMProc to preserve three lines at the top or bottom of the
  425.     local display, enter TOP or BOTTOM as desired, otherwise, enter NONE or
  426.     comment the line out.
  427.  
  428. BBS_AD_FILE
  429.     The directory path and filename for your BBS ad to be inserted into each
  430.     and every archive processed by ROMProc. Note that you must provide a path,
  431.     or it will not be copied. I STRONGLY recommend against them; BBS ads are
  432.     aggravating to other sysops, so please be considerate and use the archive
  433.     comment instead. BBS ad files are the scourge of the BBS world. This
  434.     parameter is commented out by default.
  435.  
  436. COMMENT_ARC
  437.     If you want ROMProc to comment archives (if supported by the archive
  438.     format) enter YES. If not, enter NO or comment the line out. This is much
  439.     more desirable than inserting BBS ads.
  440.  
  441. DRIVE PROCESSING DEFINITIONS:
  442. ─────────────────────────────
  443. PROC_DRIVE
  444.     Specify the drive letters for file preprocessing (BBS ad insertion and/or
  445.     commenting). Any file requested from a non-specified drive will still be
  446.     tranmitted (unmodified) from the original location. This allows
  447.     preprocessing of certain drives (e.g. CD-ROMs), but not all. Drives may be
  448.     specified in ranges, seperated by a hyphen, and/or individual drives may be
  449.     seperated by spaces, commas or semi-colons. The following examples are all
  450.     valid, and will select drives letters C through J:
  451.         PROC_DRIVE C-J
  452.         PROC_DRIVE C D E F G H I J
  453.         PROC_DRIVE C-F G H-J
  454.         PROC_DRIVE C-F,G-I,J
  455.  
  456. LOCK_DRIVE
  457.     Specify the drive letters for locking, by entering the individual drives to
  458.     be locked, one drive per line. Ranges may be seperated by a hyphen, and/or
  459.     individual drives may be seperated by spaces, commas or semi-colons. Note
  460.     that you normally lock physical drives. If you have multiple logical drives
  461.     per physical drive (e.g. a CD-ROM changer), list all the logical drive
  462.     letters on the same LOCK_DRIVE line. Each LOCK_DRIVE line constitutes a
  463.     single drive unit as far as ROMProc is concerned. It is not required that
  464.     all drives defined to be processed be locked. In this example, drive D will
  465.     be locked if accessed by ROMProc and drives E-J will be locked if ROMProc
  466.     accesses any drive from E to J.
  467.         LOCK_DRIVE D
  468.         LOCK_DRIVE E-J
  469.  
  470. LOCK_TIME
  471.     This is the amount of time (in seconds) that ROMProc will wait for a drive
  472.     to unlock. If this time is exceeded, ROMProc will abort the transfer. I
  473.     would recommend that at least 10 seconds be given, more if you are using
  474.     CD-ROM changers and/or slow networks.
  475.  
  476. COMMUNICATION DEFINITIONS:
  477. ──────────────────────────
  478. COMM_IO
  479.     If you want ROMProc to output status information to the user on-line, enter
  480.     YES; if you do not want ROMProc to output information, enter NO or comment
  481.     the line out. Note that the -P and -S command line switches must be passed
  482.     for user status information to be generated by ROMProc. The output looks
  483.     similar to the following, depending upon the prompts selected:
  484.  
  485.         Please wait while preparing your files for download...
  486.             FILE1.ZIP...
  487.             FILE2.ZIP...
  488.             [ etc. ]
  489.         Preparation complete.  Begin your download now...
  490.  
  491. PROC_PROMPT
  492.     This line of text will be displayed to the user upon the start of download
  493.     file processing. It should be used to inform the user that it may take a
  494.     few moments to get the files ready.
  495.  
  496. DL_PROMPT
  497.     This line of text will be displayed to the user upon the start of the
  498.     transfer protocol. It should be used to inform the user to start the
  499.     download on their end.
  500.  
  501. DELAY_PROMPT
  502.     This line of text will be displayed to the user if ROMProc waits for a
  503.     locked drive to unlock for 5 seconds.
  504.  
  505. ARCHIVER DEFINITIONS:
  506. ─────────────────────
  507. Each archiver, is denoted by ARCHIVER x, where x is a sequential number. Up to
  508. 10 archivers can be executed by ROMproc. ROMProc is capable of automatically
  509. detecting ARC, ARJ, HYP, LZH, PAK, SQZ, ZIP and ZOO archives. The next 4
  510. keywords are required after the ARCHIVER statement; do not comment any of them
  511. out or insert other parameters or comments between them. I would also advise
  512. against changing the command options I have set, unless you have need to do so.
  513. Any other archiver can be added, if desired; the only requirement is that the
  514. archiver must return a DOS errorlevel so that ULP can determine if it ran
  515. properly. If you do not explicitly define the path to your archiver(s), it must
  516. in a directory included in the DOS PATH environment variable.
  517.     ARCHIVER    = denotes a new archiver definition.
  518.     ARC_EXT     = the extension for this particular archiving format.
  519.     ARC_ADD     = the command line to add files to an archive, including all
  520.                   command-line switches desired. Place the variable @ARCHIVE@
  521.                   where the filename is to be inserted in the command line and
  522.                   @FILE@ where the filespec is to be inserted.
  523.     ARC_COMMENT = the command line to comment archives, including all command-
  524.                   line switches desired. Place the variable @ARCHIVE@ where the
  525.                   filename is to be inserted in the command line. If the
  526.                   archive utility does not support commenting, leave this line
  527.                   blank.
  528.     ARC_ERR     = the errorlevel that the archiver returns upon success. This
  529.                   information should be available in the program's
  530.                   documentation.
  531.  
  532. PROTOCOL DEFINITIONS:
  533. ─────────────────────
  534. Each protocol, is denoted by PROTOCOL x, where x is the letter designating the
  535. protocol. Up to 15 protocols can be executed by ROMproc. The next keyword is
  536. required after the PROTOCOL statement; do not comment it out or insert other
  537. parameters or comments between them. I have configured most of the popular
  538. protocols, using the PCBoard default lettering scheme. If you do not explicitly
  539. define the path to your archiver(s), it must in a directory included in the DOS
  540. PATH environment variable.
  541.     PROTOCOL    = denotes a new protocol definition
  542.     PROT_SEND   = the command line to transmit the file(s) to remote, including
  543.                   all command-line switches desired. Place the following
  544.                   variables as needed for ROMProc to properly invoke the
  545.                   protocol.
  546.                   @PORT@     COM port to be used by the protocol
  547.                   @SPEED@    COM port computer-to-modem speed (DTE)
  548.                   @CARRIER@  modem-to-modem carrier speed (DCE)
  549.                   @FILE@     File (or batch list file) to be downloaded
  550.                   @ULDIR@    path to upload directory for bi-directional
  551.                              protocols.
  552.  
  553.  
  554. ┌──────────────┐
  555. │  9. Support  │
  556. └──────────────┘
  557.  
  558. If you require support for ROMProc, I can be contacted by any of the following
  559. means:
  560.  
  561.     ∙ Fidonet netmail (node:  1:276/112)
  562.     ∙ Intelec BBS Doors conferences
  563.     ∙ RoseNet routed mail (system ID:  BB-P)
  564.     ∙ The ULP Support conference (#42) on Salt Air (PCBoard support BBS)
  565.     ∙ The Support conference (#2) on my BBS (listed at the top of this
  566.       document).
  567.  
  568.  
  569. ┌─────────────────────────────┐
  570. │  10. The Future of ROMProc  │
  571. └─────────────────────────────┘
  572.  
  573. ROMProc will be supported as long as I'm in the BBSing business (which will be
  574. quite a while...once it's in your blood, you can never shake it <g>). The
  575. ROMProc system will be continually expanding it's features, so get your
  576. comments in now! Some current plans:
  577.  
  578.       ∙ Add code enabling ROMProc to output status information to the remote
  579.         user for long batch processing on slow systems.
  580.       ∙ Any ideas from you guys? Thanks! <g>
  581.  
  582. If you have any other suggestions, contact me by U.S. snail-mail or on my BBS
  583. at the number at the top of this document.
  584.  
  585. Thanks for giving ROMProc a try!
  586.  
  587.  
  588. ┌────────────────────────────────┐
  589. │  Appendix A:  DOS Errorlevels  │
  590. └────────────────────────────────┘
  591.  
  592. The following is a list of the errorlevels than can be returned by ROMProc. The
  593. reason the successful execution errorlevel may not be zero is because ROMProc,
  594. upon error-free completion, returns the errorlevel of protocol, which makes
  595. ROMProc completely transparent to the BBS software.
  596.  
  597.         0           Successful execution (usually, depends on the protocol)
  598.         99          Help screen (executing a program with no or an
  599.                         insufficient number of arguments)
  600.         100         Could not close all open files
  601.         101         Invalid command-line parameter
  602.         102         Configuration file not found
  603.         103         No download file (or batch list file) specified
  604.         104         No transfer protocol specified
  605.         108         Invalid configuration file format (archiver definitions)
  606.         109         Invalid configuration file format (protocol definitions)
  607.         110         Unable to allocate heap memory
  608.         112         Invalid registration code
  609.         117         Invalid node number
  610.         120         Archiver BBS advertisement insertion error
  611.         121         Archiver commenting error
  612.         122         Time out waiting for a slow drive to unlock
  613.         125         Communication system for online status failure
  614.         200         Undefined error (internal to ROMProc program)
  615.